Cancel Replenishment Task
Active staff Bearer tokens have full mutation authority regardless of Admin replenishment ACL grants.
Staff cancellation can resolve another operator’s claim; stock in custody enters exception and remains explicit.
A blocked, unclaimed root with no current physical custody or inconsistent current custody evidence may be retired
with a required explanation. Completed physical movement history is retained and does not prevent retirement.
Task revision guards supervisor mutations; a heartbeat alone does not invalidate an earlier supervisor form.
Cancels only unpicked quantity using optimistic concurrency. Custody-bearing work remains
assigned and must be placed, returned, or exception-routed. Requires a staff Bearer token and
an Idempotency-Key; retrying the same key and body returns the task’s current state
without repeating the cancellation.
Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Headers
Caller-generated retry identity unique to this task cancellation.
1 - 64^[A-Za-z0-9._:-]+$Path Parameters
Warehouse identity.
Replenishment task identity.
x >= 1Body
Task revision observed by the caller.
x >= 1Claim lease version observed by the caller.
x >= 0Structured cancellation reason.
no_longer_needed, wrong_quantity, location_problem, operator_unavailable, other, operator_request 1 - 64Optional operator explanation; a non-empty explanation is required for other or to retire a blocked, unclaimed root.
255Response
Task state after the committed cancellation.
Durable, read-only snapshot of Replenishment work. Quantity fields are expressed in the
replenished Product's units. In Product quanta at the applicable LCM, qty_planned_total
equals the sum of unpicked, custody, placed, canceled, short/exception, and externally
satisfied quantities. Independently rounded decimal fields may not sum exactly. Mutations use the
task_revision and claim_lease_version compare-and-swap values.
Empty relationship expansion dictionary.
Additional metadata pertaining to the response.